/*
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package erwiki.plugins;

import java.security.Principal;
import java.util.HashMap;
import java.util.Map;

import erwiki.api.WikiPartReference;
import erwiki.api.auth.ISessionMonitor;
import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;
import erwiki.api.plugin.WikiPlugin;
import erwiki.util.TextUtil;

/**
 * Плагин ErWiki. Выводит информацию об активных вики-сессиях. Параметр <code>property</code>
 * указывает какая информация отображается. Если этот параметр опущен, то возвращается количество
 * сеансов.
 * <p>
 * Параметры плагина:
 * <ul>
 * <li><b>property</b> - указывает, какой вывод отображать. Допустимые значения:</li>
 * <ul>
 * <li><code>users</code> - возвращает список пользователей, разделенных запятыми.</li>
 * <li><code>distinctUsers</code> - будет показывать только отдельных пользователей.</li>
 * </ul>
 * </ul>
 */
public class SessionsPlugin implements WikiPlugin {

	/** Имя параметра для указания типа вывода. Значение <tt>{@value}</tt>. */
	public static final String PARAM_PROP = "property";

	@WikiPartReference
	ISessionMonitor sessionMonitor;

	/** {@inheritDoc} */
	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		String prop = params.get(PARAM_PROP);

		if ("users".equals(prop)) {
			Principal[] principals = sessionMonitor.userPrincipals();
			StringBuilder s = new StringBuilder();
			for (Principal principal : principals) {
				s.append(principal.getName()).append(", ");
			}
			// убрать последнюю запятую и пробел:
			return TextUtil.replaceEntities(s.substring(0, s.length() - (s.length() > 2 ? 2 : 0)));
		}

		// показывать каждый сеанс пользователя только один раз
		// (со счетчиком, указывающим количество сеансов для каждого пользователя)
		if ("distinctUsers".equals(prop)) {
			Principal[] principals = sessionMonitor.userPrincipals();
			// не предполагается, что принципалы отсортированы, поэтому сначала посчитаем их:
			HashMap<String, Integer> distinctPrincipals = new HashMap<>();
			for (Principal principal : principals) {
				String principalName = principal.getName();

				if (distinctPrincipals.containsKey(principalName)) {
					// запись у нас уже есть, увеличиваем счетчик:
					int numSessions = distinctPrincipals.get(principalName);
					// сохранить новое значение:
					distinctPrincipals.put(principalName, ++numSessions);
				} else {
					// если этот элемент встретился впервые, то добавить его в HashMap со значением 1
					distinctPrincipals.put(principalName, 1);
				}
			}

			StringBuilder s = new StringBuilder();
			for (Map.Entry<String, Integer> entry : distinctPrincipals.entrySet()) {
				s.append(entry.getKey()).append("(").append(entry.getValue().toString()).append("), ");
			}
			// убрать последнюю запятую и пробел:
			return TextUtil.replaceEntities(s.substring(0, s.length() - (s.length() > 2 ? 2 : 0)));

		}

		return String.valueOf(sessionMonitor.sessions());
	}

}
